Summary

It was recently recommended to do an audit of our documentation. This PR includes the changes I recommend.

Additionally, we migrated from the now-deprecated storybook addon-info to addon-docs, however the parameters api for attaching component descriptions to storybook changed. This PR updates our stories to display the brief descriptions and, more importantly, source links to the original uswds components. ed171f9 For example:

Finally, while looking through storybook I was reminded that the documentation around our component props does not populate default values for optional props. This is solved by doing prop restructuring in the functional component signature rather than in the method body. 27f16c2 For example:

export const GovBanner = ({
    tld = '.gov',
    language = 'english',
    className,
    ...sectionProps
}: GovBannerProps & JSX.IntrinsicElements['section']): React.ReactElement => {
  // Rest of functional component logic/rendering
}

Instead of:

export const GovBanner = (
  props: GovBannerProps & JSX.IntrinsicElements['section']
): React.ReactElement => {
  const {
    tld = '.gov',
    language = 'english',
    className,
    ...sectionProps
  } = props
  // Rest of functional component logic/rendering
}

yielding:

How To Test

• Mostly copy changes, so proofreading and double checking links would be the best way.
• Unit tests and compilation help ensure confidence that prop destructuring changes didn't break components
• Storybook changes can be seen in the PR storybook deployment.